home *** CD-ROM | disk | FTP | other *** search
/ World of Video / World of Video.iso / gfxprograms / boards / retina / rblanke2.lha / RBlankers / RCurves.doc < prev    next >
Text File  |  1994-07-12  |  13KB  |  318 lines
  1. RCurves Manual
  2. ------------
  3.  
  4.  
  5.      NAME
  6.      ----    
  7.         SYS:WBStartup/RCurves
  8.  
  9.      SYNOPSIS
  10.      --------
  11.          RShapes | 
  12.         RCurves      CX_POPKEY=<HotKey>
  13.                      CX_POPUP=<YES | NO>
  14.                      BLANKKEY=<HotKey>
  15.                      TIMEOUT=<1 - 3600>
  16.                      CLIENTTIMEOUT=<1 - 60>
  17.                      LINES=<10 - 300>
  18.                      SPEED=<1 - 10>
  19.  
  20.      This software is FREEWARE.  It may be freely distributed for non-commercial use.        
  21.     All rights are reserved by the author.              
  22.    
  23.  
  24.      DESCRIPTION
  25.      -----------
  26.           RCurves is a screen blanker with two levels of protection, the
  27.         first of which is an animation of a rotating curved set of
  28.     lines.  If the CPU is to busy, RCurves will default to disabling the 
  29.     screen altogether, preventing the animation from burning into the 
  30.     screen.
  31.  
  32.  
  33.      REQUIREMENTS
  34.      ------------
  35.  
  36.           AmigaDOS 2.04 or better and a Retina graphics card.
  37.  
  38.       Version 2.2 of the Retina software.  1.4 should still
  39.       work but is no longer tested.
  40.  
  41.           68030/040 and 68881/2.
  42.  
  43.      PURPOSE
  44.      -------
  45.  
  46.           RCurves/RShapes is a screenblanker.  
  47.           
  48.           A screen blanker's goal is to blank (disable) the screen output
  49.         in order to prevent burning images into the monitor's phosphor, but
  50.         just to disabling the screen is boring.  Instead, RCurves displays a
  51.         configurable collection of moving lines to amuse you and to remind
  52.         you that the computer is still running.
  53.  
  54.  
  55.      STARTING
  56.      --------
  57.  
  58.           RCurves is a Commodity, so it only runs under WB 2.04 and higher.
  59.         Just drop it in your WBStartup drawer so that it will load
  60.         automatically upon boot-up.  Just copy RCurves and RCurves.info to
  61.         SYS:WBStartup (or drag its icon to the WBStartup drawer).  It also
  62.         requires the Retina hardware and will not run if you don't have it.
  63.  
  64.           To start RCurves without rebooting, just double-click on its icon.
  65.         If the Tool Types haven't been changed, a window will be displayed.
  66.         This is the "option panel" of RCurves.  To see it blank the screen,
  67.         click on the "Blank" button.  To remove the option panel, click on
  68.         the "Hide" button.
  69.  
  70.           You can also start RCurves from the CLI, just use the form:
  71.  
  72.                   RUN >NIL: <NIL: RCurves {arguments}
  73.  
  74.           The arguments for CLI-Start are exactly the same as the
  75.         ToolTypes,  (See below)
  76.  
  77.  
  78.      ARGUMENTS
  79.      ---------
  80.  
  81.           RCurves supports the standard Tool Type entries for commodities.
  82.         To set them, click on the RCurves icon and select "Information" from
  83.         the Icons menu.  (Please refer to your AmigaDOS Manual for more
  84.         information on commodities and Tool Types.)
  85.  
  86.  
  87.           SUPPORTED TOOL TYPES:
  88.           ---------------------
  89.  
  90.           DONOTWAIT              When started from WBStartup, this lets WB
  91.                                  know that it shouldn't wait for RCurves to
  92.                                  finish.  This tool type should >always< be
  93.                                  present.
  94.           
  95.           STARTPRI=<n>           This sets RCurves' priority to "n".  "n"
  96.                                  should be a number between -120 and 120.
  97.                                  When started from WBStartup, this value
  98.                                  determines RCurves priority in the
  99.                                  commodities list.  It should be a negative
  100.                                  number (i.e., low priority) so that all
  101.                                  other commodities have a chance to modify
  102.                                  the input stream before RCurves sees it.
  103.  
  104.           CX_POPKEY=<HotKey>     This sets the key sequence that will open
  105.                                  RCurves' option panel.  Please see below for
  106.                                  HotKey definitions.  Defaults to "shift
  107.                                  alt s".
  108.  
  109.           CX_POPUP=<YES | NO>    If this is set to "NO"  RCurves will start
  110.                                  silently.  If it is set to anything else,
  111.                                  RCurves will open its option panel when it
  112.                                  starts.
  113.  
  114.           BLANKKEY=<HotKey>      This defines the key sequence that will
  115.                                  instantly blank the screen.  Please see
  116.                                  below for HotKey definitions.  The default
  117.                                  blanking key is "lamiga s".
  118.  
  119.           TIMEOUT=<1 - 3600>     This sets the amount of time over which no
  120.                                  input events may occur in order for the
  121.                                  screen to blank.
  122.  
  123.           CLIENTTIMEOUT=<1 - 6>  This sets the maximum time RCurves will try
  124.                                  to draw the animation.  If RCurves can't
  125.                                  update the animation at least this often,
  126.                                  it will disable the screen.  This keeps
  127.                                  the lines from burning into the monitor,
  128.                                  and it also keeps RCurves from wasting CPU
  129.                                  time when another program needs it.
  130.  
  131.           LINES=<10 - 300>       The number of lines in the curve..
  132.  
  133.           SPEED=<1-10>           The speed (10 is fastest) of the curve's
  134.                                  movement.
  135.  
  136.           NOTE: ToolTypes are case-sensitive, so make sure your
  137.         capitalization matches that shown above.
  138.  
  139.  
  140.      DEFAULT TOOL TYPES
  141.      ------------------
  142.  
  143.           When installed, RCurves has the following Tool Types:
  144.  
  145.           DONOTWAIT              # Tell WB to not wait for RCurves to finish.
  146.           CX_POPUP=YES           # Display the window when starting
  147.           STARTPRI=-120          # Sets a low CX priority for starting
  148.  
  149.  
  150.      HOT KEYS
  151.      --------
  152.  
  153.           Refer to your AmigaDOS Manual ("The Extras Programs/The Commodities
  154.         Drawer") to get a valid list of the available hot keys, the following 
  155.     may be obsolete with a new Commodities.library version:
  156.  
  157.         SYNOPSIS:  [<qualifier> [<qualifier>...]] <key>
  158.  
  159.              Qualifier keywords (Press and hold one or more qualifier)
  160.  
  161.              alt                 either Alt key
  162.              ralt                right Alt key
  163.              lalt                left Alt key
  164.              shift               either Shift key
  165.              rshift              right Shift key
  166.              lshift              left Shift key
  167.              capslock            Caps Lock key
  168.              rcommand            right Amiga key
  169.              lcommand            left Amiga key
  170.              control             Control key
  171.              numericpad          Enables the use of a key on the numeric
  172.                                  keypad
  173.              rbutton             Click (and hold) the right mouse button
  174.              midbutton           Click (and hold) the middle mouse button
  175.                                  (only avail for mice with three buttons.)
  176.              leftbutton          Click (and hold) the left mouse button
  177.              newprefs            Preferences changed
  178.              diskremoved         Disk removed
  179.              diskinserted        Disk inserted
  180.  
  181.  
  182.              Keys (to be pressed and released, only ONE Key can be chosen)
  183.  
  184.              a..z, 0..9, etc.    Normal keys
  185.              f1 .. f10           Function keys
  186.              up down left right  Cursor keys
  187.              help                Help key
  188.              del                 Delete key
  189.              return              Return key
  190.              enter               Enter key (MUST be combined with
  191.                                  'numericpad'!)
  192.              backspace           Backspace key
  193.              esc                 Escape key
  194.              space               Space key
  195.              comma               Comma key
  196.              upstroke            Upstroke key
  197.  
  198.  
  199.              Examples:
  200.  
  201.                   lalt ralt enter
  202.                   ramiga f10
  203.                   alt x
  204.                   lalt numericpad enter
  205.  
  206.           NOTE: Choose your hotkeys carefully.  Commodities can change the
  207.         way standard keys operate, and if you assign "a" to blank the
  208.         screen, then the screen will blank every time you push it - even
  209.         when you're trying to type.
  210.  
  211.           If you try to use an illegal hot key combination, RCurves will not
  212.         start, but will display an error message, instead.  Some examples
  213.         of illegal hot keys are:
  214.  
  215.           lalt a b               # Two keys specified
  216.           leftbutton             # No key specified
  217.           control lcommand rcommand   # Reboots the system (oops!)
  218.  
  219.      EDIT WINDOW
  220.      -----------
  221.  
  222.           Some RCurves settings can be changed while RCurves is executing.  To
  223.         change the settings, open the RCurves option window by pressing the
  224.         CX_POPKEY sequence you defined.  Changes made in the option window
  225.         will not be saved.
  226.  
  227.           When the option panel opens, you will see some gadgets and a
  228.     scrollable list of display modes.
  229.  
  230.           TIMER:                 The value for the timeout of the blanker.
  231.                                  After this time (in seconds) the blanker
  232.                                  will display the animation. TIMER may have a
  233.                                  value between between 1 and 3600.
  234.  
  235.           CLIENT TIMEOUT:        The time RCurves gives the animation
  236.                                  routines to update the screen.  If the
  237.                                  animation routines exceed this limit, the
  238.                                  screen will be blacked out to prevent
  239.                                  burn-ins.
  240.  
  241.           SPEED:                 The maximum pixels per frame the lines will
  242.                                  move.
  243.  
  244.           LINES:                 The number of lines.
  245.  
  246.           HIDE:                  (click or press 'h') Closes the option
  247.                                  window, without stopping RCurves.
  248.  
  249.           BLANK:                 (click or press 'b') Immediately blanks
  250.                                  the screen.
  251.  
  252.           QUIT:                  (click or press 'q') Quit.
  253.  
  254.      COMMODITIES EXCHANGE
  255.      --------------------
  256.  
  257.        With the Exchange tool, you can temporarly disable or permanently
  258.     kill RCurves and other commodities.  Please refer to the AmigaDOS Manual
  259.     (Section AmigaDOS Reference and Workbench Programs) for further
  260.     information on Exchange.
  261.  
  262.      COMMON PROBLEMS
  263.      ---------------
  264.  
  265.      1)   You are running a C-Compiler or a raytracer.  RCurves blanks but
  266.           doesn't show the lines, or the lines only appear erraticly.
  267.  
  268.           If the CPU usage is high, RCurves will simply blank the screen.
  269.           This keeps RCurves from degrading the speed of other processes, and
  270.           it prevents the animation from burning the monitor by getting stuck 
  271.       in one place too long.
  272.  
  273.           Another time this can occur is when you're using all the Retina's
  274.           video memory for other screens.  If this happens, RCurves will
  275.           first try to open a low resolution screen instead of the normal
  276.           high res one.  If >that< fails, RCurves will resort to simply
  277.           blanking the screen.
  278.      
  279.      2)   RCurves blanks the screen, but the lines are all lo-res and chunky
  280.           looking. (whine whine)
  281.      
  282.           See the previous note.  If RCurves can't open a high res screen, it
  283.           tries to open a low-res one.  If that fails, it just blacks out
  284.           the screen.
  285.  
  286.      3)   When a disk is inserted, RCurves "unblanks".  This is normal.
  287.           Disk-replacement is detected as an input event. As all input
  288.           events disable the blanker, this one does as well.
  289.  
  290.      4)   RCurves displays the window though the Tool Type CX_POPUP is set to
  291.           'NO'.
  292.  
  293.           This happens when RCurves is started but another copy is already
  294.           running.
  295.  
  296.      CREDITS
  297.      -------
  298.  
  299.           Much of the code style and technique of this blanker was inspired
  300.         by the PD blanker ASwarmIII by Jake Rose.  He did a good job
  301.         showing me how it's done.
  302.  
  303.      
  304.      HISTORY
  305.      -------
  306.  
  307.          2.6:    Rebuilt under sas 6.51.  Also, fixed a glitch in the NewBroker
  308.     structure which could cause a enforcer hit inside the commodities 
  309.     library.
  310.  
  311.      AUTHOR
  312.      ------
  313.      
  314.           Michael Heinz
  315.       William Henry Apts, #OAK-123
  316.       Malvern, PA 19355
  317.       (610)-651-5361
  318.